kotlin-stdlib/kotlin.collections/[Common]MutableList

MutableList

interface MutableList<E> : List<E> , MutableCollection<E>

A generic ordered collection of elements that supports adding and removing elements.

Parameters

the type of elements contained in the list. The mutable list is invariant in its element type.

Functions

add

Common

abstract override fun add(element: E): Boolean

Adds the specified element to the end of this list.

abstract fun add(index: Int, element: E)

Inserts an element into the list at the specified index.

addAll

Common

abstract override fun addAll(elements: Collection<E>): Boolean

Adds all of the elements of the specified collection to the end of this list.

abstract fun addAll(index: Int, elements: Collection<E>): Boolean

Inserts all of the elements of the specified collection elements into this list at the specified index.

clear

Common

abstract override fun clear()

contains

Common

abstract operator override fun contains(element: E): Boolean

containsAll

Common

abstract override fun containsAll(elements: Collection<E>): Boolean

get

Common

abstract operator fun get(index: Int): E

indexOf

Common

abstract fun indexOf(element: E): Int

isEmpty

Common

abstract override fun isEmpty(): Boolean

iterator

Common

abstract operator override fun iterator(): Iterator<E>

lastIndexOf

Common

abstract fun lastIndexOf(element: E): Int

listIterator

Common

abstract override fun listIterator(): MutableListIterator<E>

abstract override fun listIterator(index: Int): MutableListIterator<E>

remove

Common

abstract override fun remove(element: E): Boolean

removeAll

Common

abstract override fun removeAll(elements: Collection<E>): Boolean

removeAt

Common

abstract fun removeAt(index: Int): E

Removes an element at the specified index from the list.

retainAll

Common

abstract override fun retainAll(elements: Collection<E>): Boolean

set

Common

abstract operator fun set(index: Int, element: E): E

Replaces the element at the specified position in this list with the specified element.

subList

Common

abstract override fun subList(fromIndex: Int, toIndex: Int): MutableList<E>

Properties

size

Common

abstract override val size: Int

Inheritors

AbstractMutableList

ArrayList

Extensions

asReversed

Common

@JvmName(name = "asReversedMutable")

fun <T> MutableList<T>.asReversed(): MutableList<T>

Returns a reversed mutable view of the original mutable List. All changes made in the original list will be reflected in the reversed one and vice versa.

fill

Common

fun <T> MutableList<T>.fill(value: T)

inline fun <T> MutableList<T>.fill(value: T)

fun <T> MutableList<T>.fill(value: T)

Fills the list with the provided value.

remove

Common

~~inline~~ ~~fun~~ <T> MutableList<T>.~~remove~~(~~index~~: Int): T

Removes the element at the specified index from this list. In Kotlin one should use the MutableList.removeAt function instead.

removeAll

Common

fun <T> MutableList<T>.removeAll(predicate: (T) -> Boolean): Boolean

Removes all elements from this MutableList that match the given predicate.

removeFirst

Common

fun <T> MutableList<T>.removeFirst(): T

Removes the first element from this mutable list and returns that removed element, or throws NoSuchElementException if this list is empty.

removeFirstOrNull

Common

fun <T> MutableList<T>.removeFirstOrNull(): T?

Removes the first element from this mutable list and returns that removed element, or returns null if this list is empty.

removeLast

Common

fun <T> MutableList<T>.removeLast(): T

Removes the last element from this mutable list and returns that removed element, or throws NoSuchElementException if this list is empty.

removeLastOrNull

Common

fun <T> MutableList<T>.removeLastOrNull(): T?

Removes the last element from this mutable list and returns that removed element, or returns null if this list is empty.

replaceAll

Native

fun <T> MutableList<T>.replaceAll(transformation: (T) -> T)

Replaces each element in the list with a result of a transformation specified.

retainAll

Common

fun <T> MutableList<T>.retainAll(predicate: (T) -> Boolean): Boolean

Retains only elements of this MutableList that match the given predicate.

reverse

fun <T> MutableList<T>.reverse()

Reverses elements in the list in-place.

shuffle

Common

fun <T> MutableList<T>.shuffle(random: Random)

Randomly shuffles elements in this list in-place using the specified random instance as the source of randomness.

JRE

inline fun <T> MutableList<T>.shuffle(random: Random)

Randomly shuffles elements in this mutable list using the specified random instance as the source of randomness.

Common

fun <T> MutableList<T>.shuffle()

JRE

inline fun <T> MutableList<T>.shuffle()

Randomly shuffles elements in this mutable list.

fun <T> MutableList<T>.shuffle()

Randomly shuffles elements in this list.

sort

~~inline~~ ~~fun~~ <T> MutableList<T>.~~sort~~(~~comparator~~: Comparator<in T>)

~~inline~~ ~~fun~~ <T> MutableList<T>.~~sort~~(~~comparison~~: (T, T) -> Int)

fun <T : Comparable<T>> MutableList<T>.sort()

Sorts elements in the list in-place according to their natural sort order.

sortBy

Common

inline fun <T, R : Comparable<R>> MutableList<T>.sortBy(crossinline selector: (T) -> R?)

Sorts elements in the list in-place according to natural sort order of the value returned by specified selector function.

sortByDescending

Common

inline fun <T, R : Comparable<R>> MutableList<T>.sortByDescending(crossinline selector: (T) -> R?)

Sorts elements in the list in-place descending according to natural sort order of the value returned by specified selector function.

sortDescending

Common

fun <T : Comparable<T>> MutableList<T>.sortDescending()

Sorts elements in the list in-place descending according to their natural sort order.

sortWith

Common

fun <T> MutableList<T>.sortWith(comparator: Comparator<in T>)

Sorts elements in the list in-place according to the order specified with comparator.